/*
 * Copyright (C) 2009,2010 University of Paderborn, Computer Networks Group
 * Copyright (C) 2009,2010 Christian Dannewitz <christian.dannewitz@upb.de>
 * Copyright (C) 2009,2010 Thorsten Biermann <thorsten.biermann@upb.de>
 * 
 * Copyright (C) 2009,2010 Eduard Bauer <edebauer@mail.upb.de>
 * Copyright (C) 2009,2010 Matthias Becker <matzeb@mail.upb.de>
 * Copyright (C) 2009,2010 Frederic Beister <azamir@zitmail.uni-paderborn.de>
 * Copyright (C) 2009,2010 Nadine Dertmann <ndertmann@gmx.de>
 * Copyright (C) 2009,2010 Michael Kionka <mkionka@mail.upb.de>
 * Copyright (C) 2009,2010 Mario Mohr <mmohr@mail.upb.de>
 * Copyright (C) 2009,2010 Felix Steffen <felix.steffen@gmx.de>
 * Copyright (C) 2009,2010 Sebastian Stey <sebstey@mail.upb.de>
 * Copyright (C) 2009,2010 Steffen Weber <stwe@mail.upb.de>
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the University of Paderborn nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package netinf.node.gp.datamodel;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import netinf.node.gp.messages.GPNetInfMessages.NICapability;
import netinf.node.gp.messages.GPNetInfMessages.NIResolution;
import netinf.node.gp.messages.GPNetInfMessages.NIResolution.Builder;

/**
 * A {@link Resolution} is the reply from GP to the question for a suitable node with a particular {@link Capability}. The
 * {@link Resolution#getDestinationName()} is the name of the remote NetInfNode. The {@link Resolution#getTargetAddress()} is the
 * tcp/ip address for accessing this remote NetInfNode.
 * 
 * @author PG Augnet 2, University of Paderborn
 */
public class Resolution {

   private String targetAddress;
   private String destinationName;
   private final List<Capability> capabilities;

   public Resolution(NIResolution niResoution) {
      this();

      fromProto(niResoution);
   }

   public Resolution() {
      capabilities = new ArrayList<Capability>();
   }

   public void fromProto(NIResolution niResoution) {
      List<NICapability> capabilitiesList = niResoution.getCapabilitiesList();

      for (NICapability niCapability : capabilitiesList) {
         this.addCapability(new Capability(niCapability));
      }

      destinationName = niResoution.getDestinationName();
      targetAddress = niResoution.getTargetAddress();
   }

   public void setTargetAddress(String name) {
      this.targetAddress = name;
   }

   public String getTargetAddress() {
      return targetAddress;
   }

   public void removeCapability(Capability capability) {
      getCapabilities().remove(capability);
   }

   /**
    * Removes all the {@link Capability} instances where the name equals <code>capabilityName</code>.
    * 
    * @param propertyName
    */
   public void removeCapability(String capabilityName) {
      Iterator<Capability> capabilitiesIterator = getCapabilities().iterator();

      while (capabilitiesIterator.hasNext()) {
         Capability next = capabilitiesIterator.next();

         if (next.getName() != null && next.getName().equals(capabilityName)) {
            capabilitiesIterator.remove();
         }
      }
   }

   public void addCapability(Capability capability) {
      getCapabilities().add(capability);
   }

   public NIResolution toProto() {
      Builder builder = NIResolution.newBuilder();

      for (Capability capability : getCapabilities()) {
         builder.addCapabilities(capability.toProto());
      }

      builder.setTargetAddress(targetAddress);
      builder.setDestinationName(destinationName);

      return builder.build();
   }

   public void setDestinationName(String destinationName) {
      this.destinationName = destinationName;
   }

   public String getDestinationName() {
      return destinationName;
   }

   public List<Capability> getCapabilities() {
      return capabilities;
   }

   @Override
   public String toString() {
      return "Resolution [capabilities=" + capabilities + ", destinationName=" + destinationName + ", targetAddress="
            + targetAddress + "]";
   }

}
